<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
<title>rbco.wfdocumentator</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 5196 2007-06-03 20:25:28Z wiemann $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="rbco-wfdocumentator">
<h1 class="title">rbco.wfdocumentator</h1>

<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#overview" id="id9">Overview</a></li>
<li><a class="reference internal" href="#requirements" id="id10">Requirements</a></li>
<li><a class="reference internal" href="#installation" id="id11">Installation</a></li>
<li><a class="reference internal" href="#usage" id="id12">Usage</a></li>
<li><a class="reference internal" href="#to-do" id="id13">To-do</a></li>
<li><a class="reference internal" href="#history" id="id14">History</a><ul>
<li><a class="reference internal" href="#june-2009" id="id15">0.0.1 (03-june-2009)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#credits" id="id16">Credits</a></li>
<li><a class="reference internal" href="#contribute-and-report-bugs" id="id17">Contribute and report bugs</a></li>
<li><a class="reference internal" href="#references" id="id18">References</a></li>
</ul>
</div>
<div class="section" id="overview">
<h1><a class="toc-backref" href="#id9">Overview</a></h1>
<p>This add-on for Zope and Plone aims to provide user-friendly automatically
generated documentation about workflow definitions.</p>
<p>Currently two Zope3-style views for
<tt class="docutils literal"><span class="pre">Products.DCWorkflow.interfaces.IDCWorkflowDefinition</span></tt> are provided:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">&#64;&#64;wf-graph</span></tt>: Render an image representing the workflow's states and
transitions as a graph.</li>
<li><tt class="docutils literal"><span class="pre">&#64;&#64;wf-doc</span></tt>: Render an HTML page describing the workflow. This includes
the graph mentioned above.</li>
</ul>
</div>
<div class="section" id="requirements">
<h1><a class="toc-backref" href="#id10">Requirements</a></h1>
<ul class="simple">
<li>Tested with Zope XYZ + Plone 3.2.2. However only Zope 2.x is needed
(hopefuly).</li>
<li><a class="reference external" href="http://www.graphviz.org/">Graphviz</a> <a class="footnote-reference" href="#id1" id="id2">[1]</a>. More precisely: there must be an executable called <tt class="docutils literal"><span class="pre">dot</span></tt> in the
system path and the user running Zope must have execute permission on it.</li>
<li>Other requirements are pure Python packages registered on PyPI and distutils
should handle them without problems.</li>
</ul>
<div class="warning">
<p class="first admonition-title">Warning</p>
<p class="last">It was not tested on Windows. I suspect it won't work because of the name
of the executable, i.e <tt class="docutils literal"><span class="pre">dot</span></tt> != <tt class="docutils literal"><span class="pre">dot.exe</span></tt>.</p>
</div>
</div>
<div class="section" id="installation">
<h1><a class="toc-backref" href="#id11">Installation</a></h1>
<p>This package is easy_install'able. Just make it available in your Zope Instance
and don't forget to load its ZCMLs. If you don't have any idea of what I'm
talking about please refer to <a class="reference external" href="http://plone.org/documentation/tutorial/third-party-products/installing">Installing an Add-on Product</a> <a class="footnote-reference" href="#id7" id="id8">[4]</a>.</p>
<!-- TODO: link for installing add-ons. -->
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id12">Usage</a></h1>
<p>Just use the provided views on an workflow definition. Examples (type these
URLs in your browser):</p>
<ul class="simple">
<li><a class="reference external" href="http://localhost:8080/manuaisrfb/portal_workflow/plone_workflow/&#64;&#64;wf-graph">http://localhost:8080/manuaisrfb/portal_workflow/plone_workflow/&#64;&#64;wf-graph</a></li>
<li><a class="reference external" href="http://localhost:8080/manuaisrfb/portal_workflow/plone_workflow/&#64;&#64;wf-doc">http://localhost:8080/manuaisrfb/portal_workflow/plone_workflow/&#64;&#64;wf-doc</a></li>
</ul>
<p>You can pass the following parameters to &#64;&#64;wf-graph in the query string:
<tt class="docutils literal"><span class="pre">hide_roles</span></tt> and <tt class="docutils literal"><span class="pre">hide_permissions</span></tt>. These are lists of things to hide
in the output, separated by &quot;.&quot;. Example:</p>
<ul class="simple">
<li><a class="reference external" href="http://localhost:8080/manuaisrfb/portal_workflow/plone_workflow/&#64;&#64;wf-doc?hide_roles=Anonymous.Authenticated.Member&amp;hide_permissions=Access+contents+information.List%20folder%20contents">http://localhost:8080/manuaisrfb/portal_workflow/plone_workflow/&#64;&#64;wf-doc?hide_roles=Anonymous.Authenticated.Member&amp;hide_permissions=Access+contents+information.List%20folder%20contents</a></li>
</ul>
</div>
<div class="section" id="to-do">
<h1><a class="toc-backref" href="#id13">To-do</a></h1>
<ul class="simple">
<li>Render an HTML image map, so the user can click on a state or transition
and see its description.</li>
<li>Test and adapt for Windows.</li>
<li>Make the location of the <tt class="docutils literal"><span class="pre">dot</span></tt> executable configurable.</li>
<li>i18n.</li>
<li>Write automatic tests.</li>
</ul>
</div>
<div class="section" id="history">
<h1><a class="toc-backref" href="#id14">History</a></h1>
<div class="section" id="june-2009">
<h2><a class="toc-backref" href="#id15">0.0.1 (03-june-2009)</a></h2>
<ul class="simple">
<li>First release.</li>
</ul>
</div>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id16">Credits</a></h1>
<ul class="simple">
<li>Author: Rafael Oliveira &lt;<a class="reference external" href="mailto:rafaelbco&#64;gmail.com">rafaelbco&#64;gmail.com</a>&gt;</li>
<li>The idea of using Zope3-style views to render information about workflow
definitions was inspired by Martin Aspeli's <a class="reference external" href="http://pypi.python.org/pypi/collective.wtf/">collective.wtf</a> <a class="footnote-reference" href="#id3" id="id4">[2]</a>.</li>
</ul>
</div>
<div class="section" id="contribute-and-report-bugs">
<h1><a class="toc-backref" href="#id17">Contribute and report bugs</a></h1>
<p>Help is welcome. Contact the author or file a ticket at the <a class="reference external" href="http://code.google.com/p/rbco-wfdocumentator/issues">Issue tracker</a> <a class="footnote-reference" href="#id5" id="id6">[3]</a>.</p>
</div>
<div class="section" id="references">
<h1><a class="toc-backref" href="#id18">References</a></h1>
<table class="docutils footnote" frame="void" id="id1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td><a class="reference external" href="http://www.graphviz.org/">http://www.graphviz.org/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id3" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id4">[2]</a></td><td><a class="reference external" href="http://pypi.python.org/pypi/collective.wtf/">http://pypi.python.org/pypi/collective.wtf/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id5" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id6">[3]</a></td><td><a class="reference external" href="http://code.google.com/p/rbco-wfdocumentator/issues">http://code.google.com/p/rbco-wfdocumentator/issues</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id8">[4]</a></td><td><a class="reference external" href="http://plone.org/documentation/tutorial/third-party-products/installing">http://plone.org/documentation/tutorial/third-party-products/installing</a></td></tr>
</tbody>
</table>
</div>
</div>
</body>
</html>
